Resource StructureDefinition/FHIR Server from package uk.adsv2.r4#1.6.1 (219 ms)
| Package | uk.adsv2.r4 |
| Type | StructureDefinition |
| Id | Id |
| FHIR Version | R4 |
| Source | https://simplifier.net/resolve?scope=uk.adsv2.r4@1.6.1&canonical=https://fhir.nhs.uk/StructureDefinition/AmbulanceDataSet-Receiving-Location |
| Url | https://fhir.nhs.uk/StructureDefinition/AmbulanceDataSet-Receiving-Location |
| Version | 2.0.0 |
| Status | draft |
| Date | 2021-01-26 |
| Name | AmbulanceDataSetReceivingLocation |
| Title | Ambulance Data Set Receiving Location |
| Experimental | False |
| Description | Defines the UK Core constraints and extensions on the Location resource for the minimal set of data to query and retrieve location information, with additional constraints applied to support Ambulance Data Set (ADS) conformance rules for a location receiving a Patient. |
| Purpose | This profile can be used to exchange details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
A location includes both incidental locations (a place which is used for healthcare without prior designation or authorisation) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages. |
| Copyright | Copyright © 2021 NHS Digital |
| Type | Location |
| Kind | resource |
Resources that use this resource
Resources that this resource uses
Source
{
"resourceType" : "StructureDefinition",
"url" : "https://fhir.nhs.uk/StructureDefinition/AmbulanceDataSet-Receiving-Location",
"version" : "2.0.0",
"name" : "AmbulanceDataSetReceivingLocation",
"title" : "Ambulance Data Set Receiving Location",
"status" : "draft",
"date" : "2021-01-26",
"publisher" : "NHS Digital",
"contact" : [
{
"name" : "Interoperability Team",
"telecom" : [
{
"system" : "email",
"value" : "interoperabilityteam@nhs.net",
"use" : "work"
}
]
}
],
"description" : "Defines the UK Core constraints and extensions on the Location resource for the minimal set of data to query and retrieve location information, with additional constraints applied to support Ambulance Data Set (ADS) conformance rules for a location receiving a Patient.",
"purpose" : "This profile can be used to exchange details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.\r\nA location includes both incidental locations (a place which is used for healthcare without prior designation or authorisation) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages.",
"copyright" : "Copyright © 2021 NHS Digital",
"fhirVersion" : "4.0.1",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}
],
"kind" : "resource",
"abstract" : false,
"type" : "Location",
"baseDefinition" : "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "Location",
"path" : "Location",
"short" : "Details and position information for a physical place",
"definition" : "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Location",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : ".Role[classCode=SDLC]"
}
]
},
{
"id" : "Location.id",
"path" : "Location.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isSummary" : true
},
{
"id" : "Location.meta",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Meta"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.implicitRules",
"path" : "Location.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Location.language",
"path" : "Location.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Location.text",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : [
"narrative",
"html",
"xhtml",
"display"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Narrative"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Act.text?"
}
]
},
{
"id" : "Location.contained",
"path" : "Location.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : [
"inline resources",
"anonymous resources",
"contained resources"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Resource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.extension",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.modifierExtension",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.modifierExtension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.identifier",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.identifier",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "system"
}
],
"rules" : "open"
},
"short" : "Unique code or number identifying the location to its users",
"definition" : "Unique code or number identifying the location to its users.",
"requirements" : "Organization label locations in registries, need to keep track of those.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Location.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"map" : "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"
},
{
"identity" : "servd",
"map" : "Identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}
]
},
{
"id" : "Location.identifier:odsSiteCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.identifier",
"sliceName" : "odsSiteCode",
"short" : "ODS Site code to identify the organisation at site level",
"definition" : "ODS Site code to identify the organisation at site level.",
"requirements" : "Organization label locations in registries, need to keep track of those.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"map" : "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"
},
{
"identity" : "servd",
"map" : "Identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}
]
},
{
"id" : "Location.identifier:odsSiteCode.id",
"path" : "Location.identifier.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Location.identifier:odsSiteCode.extension",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.identifier.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.identifier:odsSiteCode.use",
"path" : "Location.identifier.use",
"short" : "usual | official | temp | secondary | old (If known)",
"definition" : "The purpose of this identifier.",
"comment" : "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierUse"
}
],
"strength" : "required",
"description" : "Identifies the purpose for this identifier, if known .",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Location.identifier:odsSiteCode.type",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.identifier.type",
"short" : "Description of identifier",
"definition" : "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment" : "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements" : "Allows users to make use of identifiers when the identifier system is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-type"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "v2",
"map" : "CX.5"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Location.identifier:odsSiteCode.system",
"path" : "Location.identifier.system",
"short" : "ODS Code",
"definition" : "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment" : "Identifier.system is always case sensitive.",
"requirements" : "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Identifier.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "https://fhir.nhs.uk/Id/ods-site-code",
"example" : [
{
"label" : "General",
"valueUri" : "http://www.acme.com/identifiers/patient"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX.4 / EI-2-4"
},
{
"identity" : "rim",
"map" : "II.root or Role.id.root"
},
{
"identity" : "servd",
"map" : "./IdentifierType"
}
]
},
{
"id" : "Location.identifier:odsSiteCode.value",
"path" : "Location.identifier.value",
"short" : "The value that is unique",
"definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment" : "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Identifier.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "123456"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX.1 / EI.1"
},
{
"identity" : "rim",
"map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Location.identifier:odsSiteCode.period",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.identifier.period",
"short" : "Time period when id is/was valid for use",
"definition" : "Time period during which identifier is/was valid for use.",
"comment" : "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "per-1",
"severity" : "error",
"human" : "If present, start SHALL have a lower value than end",
"expression" : "start.hasValue().not() or end.hasValue().not() or (start <= end)",
"xpath" : "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR"
},
{
"identity" : "rim",
"map" : "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
},
{
"identity" : "v2",
"map" : "CX.7 + CX.8"
},
{
"identity" : "rim",
"map" : "Role.effectiveTime or implied by context"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Location.identifier:odsSiteCode.assigner",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.identifier.assigner",
"short" : "Organization that issued id (may be just text)",
"definition" : "Organization that issued/manages the identifier.",
"comment" : "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.assigner",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "v2",
"map" : "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity" : "rim",
"map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity" : "servd",
"map" : "./IdentifierIssuingAuthority"
}
]
},
{
"id" : "Location.status",
"path" : "Location.status",
"short" : "active | suspended | inactive",
"definition" : "The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.",
"comment" : "Note that FHIR strings SHALL NOT exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.status",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid",
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "LocationStatus"
}
],
"strength" : "required",
"description" : "Indicates whether the location is still in use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/location-status|4.0.1"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}
]
},
{
"id" : "Location.operationalStatus",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.operationalStatus",
"short" : "The operational status of the location (typically only for a bed/room)",
"definition" : "The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.",
"comment" : "Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.operationalStatus",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OperationalStatus"
}
],
"strength" : "preferred",
"description" : "The operational status if the location (where typically a bed/room).",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0116"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity" : "rim",
"map" : "CV"
},
{
"identity" : "orim",
"map" : "fhir:Coding rdfs:subClassOf dt:CDCoding"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}
]
},
{
"id" : "Location.name",
"path" : "Location.name",
"short" : "Name of the location as used by humans",
"definition" : "Name of the location as used by humans. Does not need to be unique.",
"comment" : "If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.name",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : ".name"
}
]
},
{
"id" : "Location.alias",
"path" : "Location.alias",
"short" : "A list of alternate names that the location is known as, or was known as, in the past",
"definition" : "A list of alternate names that the location is known as, or was known as, in the past.",
"comment" : "There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.",
"requirements" : "Over time locations and organizations go through many changes and can be known by different names.\n\nFor searching knowing previous names that the location was known by can be very useful.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Location.alias",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : ".name"
}
]
},
{
"id" : "Location.description",
"path" : "Location.description",
"short" : "Additional details about the location that could be displayed as further information to identify the location beyond its name",
"definition" : "Description of the Location, which helps in finding or referencing the place.",
"comment" : "Note that FHIR strings SHALL NOT exceed 1MB in size",
"requirements" : "Humans need additional information to verify a correct location has been identified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.description",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : ".playingEntity[classCode=PLC determinerCode=INSTANCE].desc"
}
]
},
{
"id" : "Location.mode",
"path" : "Location.mode",
"short" : "instance | kind",
"definition" : "Indicates whether a resource instance represents a specific location or a class of locations.",
"comment" : "This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood.",
"requirements" : "When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.mode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "LocationMode"
}
],
"strength" : "required",
"description" : "Indicates whether a resource instance represents a specific location or a class of locations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/location-mode|4.0.1"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".playingEntity[classCode=PLC].determinerCode"
}
]
},
{
"id" : "Location.type",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.type",
"short" : "Type of function performed",
"definition" : "Indicates the type of function performed at the location.",
"comment" : "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Location.type",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"binding" : {
"strength" : "required",
"description" : "The type of destination that the patient was conveyed to",
"valueSet" : "https://fhir.nhs.uk/ValueSet/AmbulanceDataSet-ReceivingLocationCAD"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".code"
}
]
},
{
"id" : "Location.telecom",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.telecom",
"short" : "Contact details of the location",
"definition" : "The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Location.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "ContactPoint"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "cpt-2",
"severity" : "error",
"human" : "A system is required if a value is provided.",
"expression" : "value.empty() or system.exists()",
"xpath" : "not(exists(f:value)) or exists(f:system)",
"source" : "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XTN"
},
{
"identity" : "rim",
"map" : "TEL"
},
{
"identity" : "servd",
"map" : "ContactPoint"
},
{
"identity" : "rim",
"map" : ".telecom"
}
]
},
{
"id" : "Location.address",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.address",
"short" : "Physical location",
"definition" : "Physical location.",
"comment" : "Additional addresses should be recorded using another instance of the Location resource, or via the Organization.",
"requirements" : "If locations can be visited, we need to keep track of their address.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.address",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Address"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD"
},
{
"identity" : "rim",
"map" : "AD"
},
{
"identity" : "servd",
"map" : "Address"
},
{
"identity" : "rim",
"map" : ".addr"
}
]
},
{
"id" : "Location.physicalType",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.physicalType",
"short" : "Physical form of the location",
"definition" : "Physical form of the location, e.g. building, room, vehicle, road.",
"comment" : "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"requirements" : "For purposes of showing relevant locations in queries, we need to categorize locations.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.physicalType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PhysicalType"
}
],
"strength" : "example",
"description" : "Physical form of the location.",
"valueSet" : "http://hl7.org/fhir/ValueSet/location-physical-type"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".playingEntity [classCode=PLC].code"
}
]
},
{
"id" : "Location.position",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.position",
"short" : "The absolute geographic location",
"definition" : "The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).",
"requirements" : "For mobile applications and automated route-finding knowing the exact location of the Location is required.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.position",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : ".playingEntity [classCode=PLC determinerCode=INSTANCE].positionText"
}
]
},
{
"id" : "Location.position.id",
"path" : "Location.position.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Location.position.extension",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.position.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.position.modifierExtension",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.position.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.position.longitude",
"path" : "Location.position.longitude",
"short" : "Longitude with WGS84 datum",
"definition" : "Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).",
"comment" : "Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Location.position.longitude",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "decimal"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)"
}
]
},
{
"id" : "Location.position.latitude",
"path" : "Location.position.latitude",
"short" : "Latitude with WGS84 datum",
"definition" : "Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).",
"comment" : "Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Location.position.latitude",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "decimal"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)"
}
]
},
{
"id" : "Location.position.altitude",
"path" : "Location.position.altitude",
"short" : "Altitude with WGS84 datum",
"definition" : "Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).",
"comment" : "Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.position.altitude",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "decimal"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)"
}
]
},
{
"id" : "Location.managingOrganization",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.managingOrganization",
"short" : "Organization responsible for provisioning and upkeep",
"definition" : "The organization responsible for the provisioning and upkeep of the location.",
"comment" : "This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.",
"requirements" : "Need to know who manages the location.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.managingOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "rim",
"map" : ".scopingEntity[classCode=ORG determinerKind=INSTANCE]"
}
]
},
{
"id" : "Location.managingOrganization.id",
"path" : "Location.managingOrganization.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Location.managingOrganization.extension",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.managingOrganization.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.managingOrganization.reference",
"path" : "Location.managingOrganization.reference",
"short" : "Literal reference, Relative, internal or absolute URL",
"definition" : "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment" : "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.reference",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1",
"ref-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.managingOrganization.type",
"path" : "Location.managingOrganization.type",
"short" : "Type the reference refers to (e.g. \"Patient\")",
"definition" : "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment" : "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRResourceTypeExt"
}
],
"strength" : "extensible",
"description" : "Aa resource (or, for logical models, the URI of the logical model).",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.managingOrganization.identifier",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.managingOrganization.identifier",
"short" : "Logical reference, when literal reference is not known",
"definition" : "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment" : "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.identifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"map" : "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"
},
{
"identity" : "servd",
"map" : "Identifier"
},
{
"identity" : "rim",
"map" : ".identifier"
}
]
},
{
"id" : "Location.managingOrganization.identifier.id",
"path" : "Location.managingOrganization.identifier.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Location.managingOrganization.identifier.extension",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.managingOrganization.identifier.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.managingOrganization.identifier.use",
"path" : "Location.managingOrganization.identifier.use",
"short" : "usual | official | temp | secondary | old (If known)",
"definition" : "The purpose of this identifier.",
"comment" : "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierUse"
}
],
"strength" : "required",
"description" : "Identifies the purpose for this identifier, if known .",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Location.managingOrganization.identifier.type",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.managingOrganization.identifier.type",
"short" : "Description of identifier",
"definition" : "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment" : "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements" : "Allows users to make use of identifiers when the identifier system is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-type"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "v2",
"map" : "CX.5"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Location.managingOrganization.identifier.system",
"path" : "Location.managingOrganization.identifier.system",
"short" : "The namespace for the identifier value",
"definition" : "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment" : "Identifier.system is always case sensitive.",
"requirements" : "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"example" : [
{
"label" : "General",
"valueUri" : "http://www.acme.com/identifiers/patient"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX.4 / EI-2-4"
},
{
"identity" : "rim",
"map" : "II.root or Role.id.root"
},
{
"identity" : "servd",
"map" : "./IdentifierType"
}
]
},
{
"id" : "Location.managingOrganization.identifier.value",
"path" : "Location.managingOrganization.identifier.value",
"short" : "The value that is unique",
"definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment" : "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "123456"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX.1 / EI.1"
},
{
"identity" : "rim",
"map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Location.managingOrganization.identifier.period",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.managingOrganization.identifier.period",
"short" : "Time period when id is/was valid for use",
"definition" : "Time period during which identifier is/was valid for use.",
"comment" : "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "per-1",
"severity" : "error",
"human" : "If present, start SHALL have a lower value than end",
"expression" : "start.hasValue().not() or end.hasValue().not() or (start <= end)",
"xpath" : "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR"
},
{
"identity" : "rim",
"map" : "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
},
{
"identity" : "v2",
"map" : "CX.7 + CX.8"
},
{
"identity" : "rim",
"map" : "Role.effectiveTime or implied by context"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Location.managingOrganization.identifier.assigner",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.managingOrganization.identifier.assigner",
"short" : "Organization that issued id (may be just text)",
"definition" : "Organization that issued/manages the identifier.",
"comment" : "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.assigner",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "v2",
"map" : "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity" : "rim",
"map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity" : "servd",
"map" : "./IdentifierIssuingAuthority"
}
]
},
{
"id" : "Location.managingOrganization.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Location.managingOrganization.display",
"short" : "Text alternative for the resource",
"definition" : "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment" : "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.partOf",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.partOf",
"short" : "Another Location this one is physically a part of",
"definition" : "Another Location of which this Location is physically a part of.",
"comment" : "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"requirements" : "For purposes of location, display and identification, knowing which locations are located within other locations is important.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.partOf",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean" : true
}
],
"code" : "Reference",
"targetProfile" : [
"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "rim",
"map" : ".inboundLink[typeCode=PART].source[classCode=SDLC]"
}
]
},
{
"id" : "Location.partOf.id",
"path" : "Location.partOf.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Location.partOf.extension",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.partOf.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.partOf.reference",
"path" : "Location.partOf.reference",
"short" : "Literal reference, Relative, internal or absolute URL",
"definition" : "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment" : "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.reference",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1",
"ref-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.partOf.type",
"path" : "Location.partOf.type",
"short" : "Type the reference refers to (e.g. \"Patient\")",
"definition" : "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment" : "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRResourceTypeExt"
}
],
"strength" : "extensible",
"description" : "Aa resource (or, for logical models, the URI of the logical model).",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.partOf.identifier",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.partOf.identifier",
"short" : "Logical reference, when literal reference is not known",
"definition" : "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment" : "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.identifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"map" : "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"
},
{
"identity" : "servd",
"map" : "Identifier"
},
{
"identity" : "rim",
"map" : ".identifier"
}
]
},
{
"id" : "Location.partOf.identifier.id",
"path" : "Location.partOf.identifier.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Location.partOf.identifier.extension",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.partOf.identifier.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.partOf.identifier.use",
"path" : "Location.partOf.identifier.use",
"short" : "usual | official | temp | secondary | old (If known)",
"definition" : "The purpose of this identifier.",
"comment" : "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierUse"
}
],
"strength" : "required",
"description" : "Identifies the purpose for this identifier, if known .",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Location.partOf.identifier.type",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.partOf.identifier.type",
"short" : "Description of identifier",
"definition" : "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment" : "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements" : "Allows users to make use of identifiers when the identifier system is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-type"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "v2",
"map" : "CX.5"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Location.partOf.identifier.system",
"path" : "Location.partOf.identifier.system",
"short" : "The namespace for the identifier value",
"definition" : "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment" : "Identifier.system is always case sensitive.",
"requirements" : "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"example" : [
{
"label" : "General",
"valueUri" : "http://www.acme.com/identifiers/patient"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX.4 / EI-2-4"
},
{
"identity" : "rim",
"map" : "II.root or Role.id.root"
},
{
"identity" : "servd",
"map" : "./IdentifierType"
}
]
},
{
"id" : "Location.partOf.identifier.value",
"path" : "Location.partOf.identifier.value",
"short" : "The value that is unique",
"definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment" : "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "123456"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX.1 / EI.1"
},
{
"identity" : "rim",
"map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Location.partOf.identifier.period",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.partOf.identifier.period",
"short" : "Time period when id is/was valid for use",
"definition" : "Time period during which identifier is/was valid for use.",
"comment" : "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "per-1",
"severity" : "error",
"human" : "If present, start SHALL have a lower value than end",
"expression" : "start.hasValue().not() or end.hasValue().not() or (start <= end)",
"xpath" : "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR"
},
{
"identity" : "rim",
"map" : "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
},
{
"identity" : "v2",
"map" : "CX.7 + CX.8"
},
{
"identity" : "rim",
"map" : "Role.effectiveTime or implied by context"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Location.partOf.identifier.assigner",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.partOf.identifier.assigner",
"short" : "Organization that issued id (may be just text)",
"definition" : "Organization that issued/manages the identifier.",
"comment" : "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.assigner",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "v2",
"map" : "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity" : "rim",
"map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity" : "servd",
"map" : "./IdentifierIssuingAuthority"
}
]
},
{
"id" : "Location.partOf.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Location.partOf.display",
"short" : "Text alternative for the resource",
"definition" : "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment" : "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.hoursOfOperation",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.hoursOfOperation",
"short" : "What days/times during a week is this location usually open",
"definition" : "What days/times during a week is this location usually open.",
"comment" : "This type of information is commonly found published in directories and on websites informing customers when the facility is available.\n\nSpecific services within the location may have their own hours which could be shorter (or longer) than the locations hours.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Location.hoursOfOperation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}
]
},
{
"id" : "Location.hoursOfOperation.id",
"path" : "Location.hoursOfOperation.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Location.hoursOfOperation.extension",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.hoursOfOperation.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.hoursOfOperation.modifierExtension",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.hoursOfOperation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.hoursOfOperation.daysOfWeek",
"path" : "Location.hoursOfOperation.daysOfWeek",
"short" : "mon | tue | wed | thu | fri | sat | sun",
"definition" : "Indicates which days of the week are available between the start and end Times.",
"comment" : "Note that FHIR strings SHALL NOT exceed 1MB in size",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Location.hoursOfOperation.daysOfWeek",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DaysOfWeek"
}
],
"strength" : "required",
"description" : "The days of the week.",
"valueSet" : "http://hl7.org/fhir/ValueSet/days-of-week|4.0.1"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}
]
},
{
"id" : "Location.hoursOfOperation.allDay",
"path" : "Location.hoursOfOperation.allDay",
"short" : "The Location is open all day",
"definition" : "The Location is open all day.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.hoursOfOperation.allDay",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}
]
},
{
"id" : "Location.hoursOfOperation.openingTime",
"path" : "Location.hoursOfOperation.openingTime",
"short" : "Time that the Location opens",
"definition" : "Time that the Location opens.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.hoursOfOperation.openingTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "time"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}
]
},
{
"id" : "Location.hoursOfOperation.closingTime",
"path" : "Location.hoursOfOperation.closingTime",
"short" : "Time that the Location closes",
"definition" : "Time that the Location closes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.hoursOfOperation.closingTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "time"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}
]
},
{
"id" : "Location.availabilityExceptions",
"path" : "Location.availabilityExceptions",
"short" : "Description of availability exceptions",
"definition" : "A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.",
"comment" : "Note that FHIR strings SHALL NOT exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Location.availabilityExceptions",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Location.endpoint",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.endpoint",
"short" : "Technical endpoints providing access to services operated for the location",
"definition" : "Technical endpoints providing access to services operated for the location.",
"comment" : "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"requirements" : "Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Location.endpoint",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Endpoint"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
}
]
},
{
"id" : "Location.endpoint.id",
"path" : "Location.endpoint.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Location.endpoint.extension",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.endpoint.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.endpoint.reference",
"path" : "Location.endpoint.reference",
"short" : "Literal reference, Relative, internal or absolute URL",
"definition" : "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment" : "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.reference",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1",
"ref-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.endpoint.type",
"path" : "Location.endpoint.type",
"short" : "Type the reference refers to (e.g. \"Patient\")",
"definition" : "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment" : "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRResourceTypeExt"
}
],
"strength" : "extensible",
"description" : "Aa resource (or, for logical models, the URI of the logical model).",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.endpoint.identifier",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.endpoint.identifier",
"short" : "Logical reference, when literal reference is not known",
"definition" : "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment" : "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.identifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"map" : "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"
},
{
"identity" : "servd",
"map" : "Identifier"
},
{
"identity" : "rim",
"map" : ".identifier"
}
]
},
{
"id" : "Location.endpoint.identifier.id",
"path" : "Location.endpoint.identifier.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Location.endpoint.identifier.extension",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.endpoint.identifier.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Location.endpoint.identifier.use",
"path" : "Location.endpoint.identifier.use",
"short" : "usual | official | temp | secondary | old (If known)",
"definition" : "The purpose of this identifier.",
"comment" : "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierUse"
}
],
"strength" : "required",
"description" : "Identifies the purpose for this identifier, if known .",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Location.endpoint.identifier.type",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.endpoint.identifier.type",
"short" : "Description of identifier",
"definition" : "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment" : "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements" : "Allows users to make use of identifiers when the identifier system is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-type"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "v2",
"map" : "CX.5"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Location.endpoint.identifier.system",
"path" : "Location.endpoint.identifier.system",
"short" : "The namespace for the identifier value",
"definition" : "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment" : "Identifier.system is always case sensitive.",
"requirements" : "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"example" : [
{
"label" : "General",
"valueUri" : "http://www.acme.com/identifiers/patient"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX.4 / EI-2-4"
},
{
"identity" : "rim",
"map" : "II.root or Role.id.root"
},
{
"identity" : "servd",
"map" : "./IdentifierType"
}
]
},
{
"id" : "Location.endpoint.identifier.value",
"path" : "Location.endpoint.identifier.value",
"short" : "The value that is unique",
"definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment" : "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "123456"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX.1 / EI.1"
},
{
"identity" : "rim",
"map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Location.endpoint.identifier.period",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.endpoint.identifier.period",
"short" : "Time period when id is/was valid for use",
"definition" : "Time period during which identifier is/was valid for use.",
"comment" : "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "per-1",
"severity" : "error",
"human" : "If present, start SHALL have a lower value than end",
"expression" : "start.hasValue().not() or end.hasValue().not() or (start <= end)",
"xpath" : "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR"
},
{
"identity" : "rim",
"map" : "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
},
{
"identity" : "v2",
"map" : "CX.7 + CX.8"
},
{
"identity" : "rim",
"map" : "Role.effectiveTime or implied by context"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Location.endpoint.identifier.assigner",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "Location.endpoint.identifier.assigner",
"short" : "Organization that issued id (may be just text)",
"definition" : "Organization that issued/manages the identifier.",
"comment" : "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.assigner",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
]
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath" : "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "v2",
"map" : "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity" : "rim",
"map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity" : "servd",
"map" : "./IdentifierIssuingAuthority"
}
]
},
{
"id" : "Location.endpoint.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Location.endpoint.display",
"short" : "Text alternative for the resource",
"definition" : "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment" : "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "Location.identifier:odsSiteCode",
"path" : "Location.identifier",
"sliceName" : "odsSiteCode"
},
{
"id" : "Location.identifier:odsSiteCode.assigner",
"path" : "Location.identifier.assigner",
"constraint" : [
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
]
},
{
"id" : "Location.type",
"path" : "Location.type",
"binding" : {
"strength" : "required",
"description" : "The type of destination that the patient was conveyed to",
"valueSet" : "https://fhir.nhs.uk/ValueSet/AmbulanceDataSet-ReceivingLocationCAD"
}
},
{
"id" : "Location.telecom",
"path" : "Location.telecom",
"constraint" : [
{
"key" : "cpt-2",
"severity" : "error",
"human" : "A system is required if a value is provided.",
"source" : "http://hl7.org/fhir/StructureDefinition/Location"
}
]
},
{
"id" : "Location.managingOrganization",
"path" : "Location.managingOrganization",
"constraint" : [
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
]
},
{
"id" : "Location.managingOrganization.identifier.assigner",
"path" : "Location.managingOrganization.identifier.assigner",
"constraint" : [
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
]
},
{
"id" : "Location.partOf",
"path" : "Location.partOf",
"constraint" : [
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
]
},
{
"id" : "Location.partOf.identifier.assigner",
"path" : "Location.partOf.identifier.assigner",
"constraint" : [
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
]
},
{
"id" : "Location.endpoint",
"path" : "Location.endpoint",
"constraint" : [
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
]
},
{
"id" : "Location.endpoint.identifier.assigner",
"path" : "Location.endpoint.identifier.assigner",
"constraint" : [
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"source" : "http://hl7.org/fhir/StructureDefinition/Identifier"
}
]
}
]
},
"text" : {
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.
FHIR